Skip to main content
Version: 4.2.x

Migrate Java XDK Android Bridge Codebase to Kotlin

We recommend using new Kotlin codebase for new projects. However, if you want to embrace the newest changes here are steps for you to get your Java code to Kotlin.

Summary​

List of changes done:

  • Added Kotlin plugin into the project
  • Dependency resolution is moved into settings.gradle
  • Added Kotlin linter plugin
  • Deprecated some of the interface classes which are unnecessary since WebView requires @JavascriptInterface for methods to be exposed. In that case, only the object methods are to be exposed
  • Analyzed and commented deprecated Android library codes
  • Updated target sdk to 31

Preparation​

  • Make sure that you backup your code
  • Clone new codebase from XDK repository
  • Open Android project placed in xdk/platform/android directory
  • Wait until the dependencies are synced and the project is build for the first time
  • From gradle console run
gradle ktlintApplyToIdeaGlobally

to apply kotlin linter into your project

  • Also add git pre-commit hook to automatically run linter task
gradle addKtlintFormatGitPreCommitHook
  • Copy method block code in your existing project and paste into kotlin file. Android Studio will promt you a dialog to convert the code.

Example:

  public void addPlayer(final MediaPlayer player) {
    player.addEventListener(mPlayerEventListener);
    addJavascriptInterface(player, player.getClass().getSimpleName());
  }
drawing
  • After clicking yes check the format of the code and make corrections if necessary.

Example: After converted code looks like this:

    fun addPlayer(player: MediaPlayer) {
        player.addEventListener(mPlayerEventListener)
        addJavascriptInterface(player, player.javaClass.simpleName)
    }
  • Repeat for other methods.

Contact​

If you need any further help about migrating your current XDK Android Bridge, please contact one of the Build Android developer.

Documentation​

You can find more information about adding kotlin onto your existing code here: https://developer.android.com/kotlin/add-kotlin